|
Required parameters
|
Desc
|
|
|
Account
|
Your
account
|
|
|
Key
|
Your
password
|
|
|
LastName
|
Offender's
Last name(support wildcard)
|
[ex: smith]
[ex: jac* = jackson]
|
|
FirstName
|
Offender's
First name (support wildcard)
|
[ex:
peter]
|
|
DisclaimersAgree
|
disclaimers_agree = true read detail
|
|
|
Optional Parameters
|
|
|
|
MiddleName
|
Offender's
middle name (support wildcard)
|
[ex: a]
|
|
IncludePartialMiddlename
|
Include
records with partial or empty middle name
|
include_partial_middlename = 1
include records that match the first letter of middlename.
include_partial_middlename = 2
Include records that match the first letter of middlename
or no middle name
|
|
Aka
|
Enable
alias names search
|
aka
=1
ex: when firstname = michael,
system will match records with 'mike', 'micky','mick'
or 'micah'
|
|
Zipcode
|
Offender's
zip code
|
5 digit number
|
|
State
|
US state
|
State
abbreviations ex: CA, OH, VA... default=All. To specify more than one state,
using comma between states such as CA,HI,AZ
|
|
Category
|
record
category
|
No specified(Default) = All categories
CR = criminal
SX = Sex Offenders
AR = Arrest
WA = Warrant
MW = Most Wanted
PA = Patriot
Or combination of any above category
Examples:
AR,WA = Arrest + Warrant
CR,SX = Criminal + Sex offenders
CR,MW = Criminal + Most Wanted
SX,PA = Sex Offenders + Patriot
CR,SX,MW = Criminal + Sex offenders + Most Wanted
CR,SX,PA = Criminal + Sex offenders + Patriot
|
|
DOB
|
Offender's
DOB
|
DOB in yyyymmdd format (support wildcard for mmdd)
[ex:19851206] [ex:1983* = 19830101 ~ 19831231]
|
|
IncludePartialDOB
|
Include
partial DOB match
|
include_partial_DOB = 1
(1)Records with DOB(exactly match)
(2)Records with partial DOB(YYYYMM match , DD = 00 or empty string)
(3)Records with partial DOB(YYYY match , MMDD = 0000 or empty string)
(4)Records with partial DOB(MMDD match , YYYY = 0000 or empty string)
include_partial_DOB = 2
include_partial_DOB = include_partial_DOB = 1 + Records with no DOB
info
include_partial_DOB = 3
include_partial_DOB = include_partial_DOB = 1 + Records with
partial DOB(YYYYMM match, DD = any date)
include_partial_DOB = 4
include_partial_DOB = include_partial_DOB = 1 + Patriot with no
DOB info
include_partial_DOB = 5
(1) Records with DOB (exactly match)
(2) Patriot with any or no DOB
include_partial_DOB = 6
(1) Include_partial_DOB=1
(2) Include CCYY match only (mmdd can be any
value)
(3) Include MMDD match only (ccyy can be any
value)
(4) SOR with any or no DOB (Name only match)
(5) Patriot with any or no DOB (Name only match)
include_partial_DOB = 7
(1) Include_partial_DOB=5
(4) SOR with exact DOB, CCYY0000 match or no DOB
|
|
PriorityStates
|
High
priority state(s)
|
Records
from these states have high priority. such as priority_states=CA,HI,AZ
|
|
PriorityFlag
|
Return
records in different priority orders
|
priority_flag = 0
1. Exact DOB Matches + High priority
states
2. Exact DOB Matches + Low priority states
3. Partial DOB Matches + High priority states
4. Partial DOB Matches + Low priority states
5. NULL DOB Matches + High priority states
6. NULL DOB Matches + Low priority states
priority_flag = 1
1. Exact DOB Matches + High priority
states
2. Partial DOB Matches + High priority states
3. NULL DOB Matches + High priority states
4. Exact DOB Matches + Low priority states
5. Partial DOB Matches + Low priority states
6. NULL DOB Matches + Low priority states
priority_flag = 2
1. Record with DOB(exactly match) + middle
name(exactly match)
2. Record with DOB(exactly match) + middle name
(the first letter match)
3 .Record with DOB(exactly match) + no middle name info
4. Record with partial DOB(YYYYMM match, DD =
00 or empty string) + middle name(exactly match)
5. Record with partial DOB(YYYYMM match, DD =
00 or empty string) + middle name(the first letter match)
6. Record with partial DOB(YYYYMM match, DD =
00 or empty string) + no middle name info
7. Record with partial DOB(YYYY match, MMDD =
0000 or empty string) + middle name(exactly match)
8. Record with partial DOB(MMDD match, YYYY =
0000 or empty string) + middle name(exactly match)
9. Record with partial DOB(YYYY match, MMDD =
0000 or empty string) + middle name (the first letter match)
10. Record with partial DOB(MMDD match, YYYY =
0000 or empty string) + middle name (the first letter match)
11. Record with partial DOB(YYYY match, MMDD =
0000 or empty string) + no middle name info
12. Record with partial DOB(YYYY match, MMDD =
0000 or empty string) + no middle name info
13. Record with no DOB info + middle name(exactly
match)
14. Record with no DOB info + middle name(the
first letter match)
15. Record with no DOB info + no middle name info
priority_flag = 3
1. Record with DOB(exactly match) + middle
name(exactly match)
2. Record with DOB(exactly match) + middle name
(the first letter match)
3 .Record with DOB(exactly match) + no middle name info
4. Record with partial DOB(YYYYMM match, DD =
00 or empty string) + middle name(exactly match)
5. Record with partial DOB(YYYYMM match, DD =
00 or empty string) + middle name(the first letter match)
6. Record with partial DOB(YYYYMM match, DD =
00 or empty string) + no middle name info
7. Record with partial DOB(YYYY match, MMDD = 0000
or empty string) + middle name(exactly match)
8. Record with partial DOB(MMDD match, YYYY =
0000 or empty string) + middle name(exactly match)
9. Record with partial DOB(YYYY match, MMDD =
0000 or empty string) + middle name (the first letter match)
10. Record with partial DOB(MMDD match, YYYY =
0000 or empty string) + middle name (the first letter match)
11. Record with partial DOB(YYYY match, MMDD =
0000 or empty string) + no middle name info
12. Record with partial DOB(YYYY match, MMDD =
0000 or empty string) + no middle name info
13. Record with partial DOB(YYYYMM match, DD =
any date) + middle name(exactly match)
14. Record with partial DOB(YYYYMM match, DD =
any date) + middle name(the first letter match)
15. Record with partial DOB(YYYYMM match, DD =
any date ) + no middle name info
16. Record with no DOB info + middle name(exactly
match)
17. Record with no DOB info + middle name(the
first letter match)
18. Record with no DOB info + no middle name info
priority_flag = 4
1. SOR Category - Records with DOB (exact match)
2. SOR Category - Records with no DOB or no DOB match
|
|
SearchType
|
specify
search type
|
0:source table (default)
1: index table
|
|
SourceLayout
|
specify
output layout for source table
|
0:
unified summary(default)
1: unified original
2. source summary
3. source original
5. hybrid 2 (unified summary) + (source fields)
6. unified summary + separated charge info
7. Layout 1 + county field
8. Layout 0 + county field
|
|
ReturnSourceMax
|
specify maximum records returned from the index table (specify range between 1~250)
|
|
|
AllSOR
|
Include
Sex Offenders records from all states
|
default =
false. To enable it, set all_sor = true
|
|
AllPatriot
|
Include
Patriot records from all states
|
default
= false. To enable it, set all_patriot = true
|
|
ReferenceID
|
Reference
|
|
|
RVP
|
Records
policy
|
1. rvp=1. Only for users that have permission to access all but
don't want to see RVP purged records in results
2. rvp=0. Return all records only if users have permission.
|
|
Source
|
Source
name
|
Return matched records from
specified sources only. For example, <Source>sorco</Source>
or <Source>sortx,sorco</Source>
|
|
|
|
|